Skip to content

v3.2: Parameter and Header example updates #4801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 26, 2025
Merged

v3.2: Parameter and Header example updates #4801

merged 3 commits into from
Jul 26, 2025

Conversation

handrews
Copy link
Member

@handrews handrews commented Jul 18, 2025 •
edited by karenetheridge
Loading

Note: This replaces the other half of PR #4673 (the first half being replaced by PR #4800), and updates parameter and header examples for PRs #4800, #4799., and #4802.

This updates for both the new example fields and for examples with content

  • no schema changes are needed for this pull request

@handrews
Parameter and Header example updates
62751e7 
This updates for both the new example fields and for examples with `content`
@handrews handrews added this to the v3.2.0 milestone Jul 18, 2025
@handrews handrews requested review from a team as code owners July 18, 2025 21:52
@handrews handrews added examples requests for more or better examples in the specification param serialization Issues related to parameter and/or header serialization media and encoding Issues regarding media type support and how to encode data (outside of query/path params) example obj/keywords Issues with the Example Object or exampel(s) keywords labels Jul 18, 2025
This was referenced Jul 18, 2025
Closed
Merged
Merged
Closed
@ralfhandl ralfhandl requested a review from a team July 19, 2025 14:43
miqui
miqui previously approved these changes Jul 19, 2025
View reviewed changes
@ralfhandl ralfhandl requested a review from a team July 19, 2025 15:08
ralfhandl
ralfhandl reviewed Jul 19, 2025
View reviewed changes
@handrews
Copy link
Member Author

@ralfhandl the email notification contained this:

In src/oas.md:

@@ -1183,11 +1273,14 @@ content:
schema:
type: string
example: $.a.b[1:1]
+examples:
examples and example can currently only be used with schema, not with content, see https://github.com/OAI/OpenAPI-Specification/blob/v3.2-dev/src/oas.md#fixed-fields-for-use-with-content.

This affects multiple examples :sad:

but I don't see it now... was this just because I had split this from PR #4802? (and accidentally posted them in the wrong order...)

@handrews handrews requested a review from a team July 19, 2025 15:58
@ralfhandl
Copy link
Contributor

Yes, I got confused for a minute and lost sight of the target picture.

ralfhandl
ralfhandl reviewed Jul 19, 2025
View reviewed changes
@ralfhandl ralfhandl requested review from a team and miqui July 19, 2025 18:05
@handrews handrews mentioned this pull request Jul 24, 2025
Closed
@miqui miqui merged commit 75ac257 into OAI:v3.2-dev Jul 26, 2025
2 checks passed
@handrews handrews deleted the param-header-ex-3 branch August 4, 2025 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ralfhandl ralfhandl ralfhandl approved these changes

@miqui miqui miqui approved these changes

Assignees

No one assigned

Labels

example obj/keywords Issues with the Example Object or exampel(s) keywords examples requests for more or better examples in the specification headers media and encoding Issues regarding media type support and how to encode data (outside of query/path params) param serialization Issues related to parameter and/or header serialization

Projects

None yet

Milestone

v3.2.0

Development

Successfully merging this pull request may close these issues.

3 participants

@handrews @ralfhandl @miqui